Skip to content

[dotnet] [bidi] Decouple EvaluateResult in Script module#15493

Merged
nvborisenko merged 1 commit intoSeleniumHQ:trunkfrom
nvborisenko:bidi-nested-evaluateresult
Mar 23, 2025
Merged

[dotnet] [bidi] Decouple EvaluateResult in Script module#15493
nvborisenko merged 1 commit intoSeleniumHQ:trunkfrom
nvborisenko:bidi-nested-evaluateresult

Conversation

@nvborisenko
Copy link
Member

@nvborisenko nvborisenko commented Mar 23, 2025 •
edited by qodo-code-review bot
Loading

User description

Following spec https://w3c.github.io/webdriver-bidi/#type-script-EvaluateResult

I chose EvaluateResultSuccess instead of commonly used SuccessEvaluateResult, preferred the same in spec.

Motivation and Context

Contributes to #15407

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

PR Type

Enhancement

Description

  • Replaced nested DTO types with standalone types for better extensibility.

  • Updated EvaluateResult structure to use EvaluateResultSuccess and EvaluateResultException.

  • Adjusted serialization and deserialization logic to align with new DTO structure.

  • Refactored related methods and exception handling to use updated DTO types.

Changes walkthrough 📝

Relevant files
Enhancement
BiDiJsonSerializerContext.cs
Updated JSON serialization for new DTO types                         

dotnet/src/webdriver/BiDi/Communication/Json/BiDiJsonSerializerContext.cs

  • Replaced nested DTO types with standalone types in JSON serialization.
  • Updated references to EvaluateResultSuccess and
    EvaluateResultException.
    		• +2/-2     
    EvaluateResultConverter.cs
    Updated deserialization logic for new DTO types                   

    dotnet/src/webdriver/BiDi/Communication/Json/Converters/Polymorphic/EvaluateResultConverter.cs

  • Adjusted deserialization logic to handle new standalone DTO types.
  • Replaced nested type references with EvaluateResultSuccess and
    EvaluateResultException.
    		• +2/-2     
    BrowsingContextScriptModule.cs
    Refactored methods to use new DTO types                                   

    dotnet/src/webdriver/BiDi/Modules/BrowsingContext/BrowsingContextScriptModule.cs

  • Updated method signatures to use EvaluateResultSuccess.
  • Refactored calls to align with new DTO structure.
    		• +2/-2     
    EvaluateCommand.cs
    Refactored EvaluateCommand to use standalone DTOs               

    dotnet/src/webdriver/BiDi/Modules/Script/EvaluateCommand.cs

  • Replaced nested EvaluateResult types with standalone
    EvaluateResultSuccess and EvaluateResultException.
  • Updated implicit conversion logic for EvaluateResultSuccess.
    		• +8/-9     
    ScriptEvaluateException.cs
    Updated exception handling for new DTO structure                 

    dotnet/src/webdriver/BiDi/Modules/Script/ScriptEvaluateException.cs

  • Updated exception handling to use EvaluateResultException.
  • Replaced nested type references with standalone DTO type.
    		• +2/-2     
    ScriptModule.cs
    Refactored ScriptModule methods for new DTO types               

    dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs

  • Refactored methods to use EvaluateResultSuccess and
    EvaluateResultException.
  • Updated exception handling logic to align with new DTO structure.
    		• +6/-6     
    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
    •

    @qodo-code-review
    Copy link
    Contributor

    qodo-code-review bot commented Mar 23, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    🎫 Ticket compliance analysis ✅

    15407 - Fully compliant

    Compliant requirements:

    • Replace nested DTO types with standalone types
    • Avoid using nested types that reserve names in the parent class
    • Enable future extensibility for static factories and singletons
    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Empty Record

    The PR introduces an empty record body for the abstract EvaluateResult class. This could be intentional, but it's worth verifying if this is the expected behavior or if there should be some common properties or methods.

     
    public abstract record EvaluateResult;

    @qodo-code-review
    Copy link
    Contributor

    qodo-code-review bot commented Mar 23, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Learned
    best practice
    Use TryGetProperty to safely check for JSON property existence before accessing it to prevent exceptions

    The code directly accesses the "type" property without checking if it exists
    first, which could throw a JsonException if the property is missing. Use
    TryGetProperty to safely check for the property's existence before accessing it.

    dotnet/src/webdriver/BiDi/Communication/Json/Converters/Polymorphic/EvaluateResultConverter.cs [34-39]

    -return jsonDocument.RootElement.GetProperty("type").ToString() switch
+if (!jsonDocument.RootElement.TryGetProperty("type", out JsonElement typeElement))
+    return null;
+    
+return typeElement.GetString() switch
 {
     "success" => jsonDocument.Deserialize<EvaluateResultSuccess>(options),
     "exception" => jsonDocument.Deserialize<EvaluateResultException>(options),
     _ => null,
 };
    • Apply this suggestion
    Suggestion importance[1-10]: 6
    		Low
    • More

    @nvborisenko nvborisenko mentioned this pull request Mar 23, 2025
    Closed
    RenderMichael
    RenderMichael approved these changes Mar 23, 2025
    View reviewed changes
    Copy link
    Contributor

    @RenderMichael RenderMichael left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    These changes look good as part of the effort to remove nested DTOs.

    In a future PR, we can change the EvaluateAsync/CallFunctionAsync to return EvaluateResult directly instead of throwing/returning success.

    @nvborisenko nvborisenko merged commit 43fcf45 into SeleniumHQ:trunk Mar 23, 2025
    10 checks passed
    @nvborisenko nvborisenko deleted the bidi-nested-evaluateresult branch March 23, 2025 20:19
    This was referenced Sep 12, 2025
    Closed
    Closed
    Merged
    This was referenced Sep 19, 2025
    Closed
    Closed
    This was referenced Oct 1, 2025
    Closed
    Closed
    @dependabot dependabot bot mentioned this pull request Oct 24, 2025
    Closed
    This was referenced Dec 21, 2025
    Open
    Closed
    Closed
    Closed
    This was referenced Jan 19, 2026
    Open
    Open
    Open
    Merged
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @RenderMichael RenderMichael RenderMichael approved these changes

    Assignees

    No one assigned

    Labels

    Review effort 2/5

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    2 participants

    @nvborisenko @RenderMichael